Get folder details including files.
  • 12 May 2026
  • 10 Minutes to read
  • Contributors
  • Dark
    Light

Get folder details including files.

  • Dark
    Light

Article summary

Get
/v3/projects/{project_id}/drive/folders/{folder_id}

Returns folder metadata along with a paginated list of files contained in the folder. The page and pageSize parameters control file pagination only; subfolder data is always returned in full. For private or mixed-visibility projects, file URLs include a time-limited SAS token by default. Returns 404 if the folder does not exist. Requires ViewDrive permission.

Security
OAuth

All V3 endpoints require a Bearer token. Generate tokens in the Document360 portal under Settings > API Tokens. Tokens are project-scoped, require the customerApi scope, and do not expire by default. Tokens can be revoked at any time from the portal. Include the token in every request: Authorization: Bearer <your-token>. Alternatively, use the Authorize button below to sign in via OAuth2 Authorization Code flow with PKCE.

FlowAuthorization Code
Authorization URLhttps://identity.document360.net/connect/authorize
Token URLhttps://identity.document360.net/connect/token
Scopes:
customerApiDocument360 Customer API
Path parameters
project_id
string (uuid) Required

The unique identifier of the project. Retrieve project IDs from GET /v3/projects.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
folder_id
string (uuid) Required

The identifier of the folder to retrieve. Retrieve folder IDs from GET /v3/projects/{projectId}/drive/folders.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
Query parameters
page
integer (int32)

Page number (1-based). Defaults to 1.

Minimum1
Default1
page_size
integer (int32)

Number of results per page. Defaults to 25. Maximum 100.

Minimum1
Maximum100
Default25
Responses
200

Folder details retrieved successfully.

Folder detail

Returns a folder with its files and pagination info

{
  "data": {
    "files": [
      {
        "id": "e5f6a7b8-9abc-def0-1234-567890abcdef",
        "file_name": "dashboard-overview.png",
        "file_type": "image/png",
        "file_url": "https://cdn.document360.io/project/images/dashboard-overview.png",
        "modified_at": "2025-07-18T11:20:00Z",
        "updated_by": "[email protected]",
        "size": "2.4 MB",
        "height": "1080",
        "width": "1920",
        "parent_folder_id": "a1b2c3d4-5678-9abc-def0-1234567890ab",
        "title": "Dashboard Overview",
        "alternative_text": "Screenshot of the main dashboard showing analytics widgets",
        "tags": [
          {
            "id": "f6a7b8c9-abcd-ef01-2345-67890abcdef0",
            "name": "dashboard"
          },
          {
            "id": "a7b8c9d0-bcde-f012-3456-7890abcdef01",
            "name": "screenshot"
          }
        ],
        "thumbnail_url": "https://cdn.document360.io/project/thumbnails/dashboard-overview.png",
        "is_starred": false
      }
    ],
    "files_pagination": {
      "page": 1,
      "page_size": 20,
      "total_count": 24,
      "has_more": true,
      "next_cursor": null
    },
    "id": "a1b2c3d4-5678-9abc-def0-1234567890ab",
    "title": "Product Screenshots",
    "parent_folder_id": null,
    "sub_folders": [],
    "items_count": 24,
    "created_at": null,
    "updated_by": "[email protected]",
    "modified_at": "2025-07-20T14:45:00Z",
    "order": 1,
    "is_starred": true
  },
  "success": true,
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "errors": null,
  "warnings": null
}
Expand All
object

Generic API response wrapper containing typed data.

data
object

Response data payload.

files
Array of object (FileResponse) | null

List of files contained in this folder.

object

Represents a file stored in the Drive file manager.

id
string (uuid) | null

Unique identifier of the file.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
file_name
string | null

Original name of the uploaded file including extension.

Examplescreenshot.png
file_type
string | null

MIME type or file extension of the file.

Exampleimage/png
file_url
string | null

Public URL to access or download the file. For private or mixed-visibility projects, a time-limited SAS token is automatically appended.

modified_at
string (date-time)

Date and time when the file was last modified.

updated_by
string | null

User ID of the person who last modified the file.

size
string | null

File size as a human-readable string (e.g., "2.5 MB").

Example2.5 MB
height
string | null

Height of the image in pixels. Applicable only for image files.

Example1080
width
string | null

Width of the image in pixels. Applicable only for image files.

Example1920
parent_folder_id
string | null

Unique identifier of the folder containing this file. Retrieve folder IDs from GET /v3/projects/{projectId}/drive/folders.

title
string | null

User-assigned display title for the file.

alternative_text
string | null

Alternative text description for the file, used for accessibility.

tags
Array of object (TagResponse) | null

Tags associated with this file for filtering and organization.

object

Represents a tag used to categorize and filter files in the Drive.

id
string (uuid) | null

Unique identifier of the tag.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
name
string | null

Display name of the tag.

Exampleproduct
thumbnail_url
string | null

URL to a smaller thumbnail preview of the file. For private or mixed-visibility projects, a time-limited SAS token is automatically appended.

is_starred
boolean

Whether this file is marked as starred/favorited by the current user.

files_pagination
object | null

Pagination metadata for the files list.

page
integer (int32)

Current page number (1-based). Returns 0 when using cursor-based pagination.

page_size
integer (int32)

Number of items per page.

total_count
integer (int64) | null

Total number of items across all pages. Only populated when include_total_count=true is specified in the request.

has_more
boolean

Whether additional pages are available.

next_cursor
string | null

Opaque cursor to retrieve the next page of results. Pass this value as the cursor query parameter. Null when there are no more pages.

id
string (uuid) | null

Unique identifier of the folder.

Example60a7b2c9e4b0f1a2b3c4d5e6
title
string | null

Display name of the folder.

ExampleProduct Screenshots
parent_folder_id
string | null

Unique identifier of the parent folder. Null if this is a root-level folder. Retrieve folder IDs from GET /v3/projects/{projectId}/drive/folders.

sub_folders
Array of object (FolderResponse) | null

List of immediate child folders nested under this folder.

object

Represents a folder in the Drive file manager.

id
string (uuid) | null

Unique identifier of the folder.

Example60a7b2c9e4b0f1a2b3c4d5e6
title
string | null

Display name of the folder.

ExampleProduct Screenshots
parent_folder_id
string | null

Unique identifier of the parent folder. Null if this is a root-level folder. Retrieve folder IDs from GET /v3/projects/{projectId}/drive/folders.

sub_folders
Array of object (FolderResponse) | null

List of immediate child folders nested under this folder.

object Recursive

Represents a folder in the Drive file manager.

items_count
integer (int32)

Total number of files contained in this folder.

created_at
string (date-time) | null

Date and time when this folder was created.

updated_by
string | null

User ID of the person who last modified this folder.

modified_at
string (date-time)

Date and time when this folder was last modified.

order
integer (int32)

Sort order position of this folder among its siblings.

is_starred
boolean

Whether this folder is marked as starred/favorited by the current user.

items_count
integer (int32)

Total number of files contained in this folder.

created_at
string (date-time) | null

Date and time when this folder was created.

updated_by
string | null

User ID of the person who last modified this folder.

modified_at
string (date-time)

Date and time when this folder was last modified.

order
integer (int32)

Sort order position of this folder among its siblings.

is_starred
boolean

Whether this folder is marked as starred/favorited by the current user.

success
boolean

Whether the API request was successful.

request_id
string

Unique identifier for request tracing and correlation.

Min length1
errors
Array of object (ApiError) | null

List of errors if the request failed.

object

Represents an error returned by the API.

code
string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1
message
string

Human-readable error message.

Min length1
field
string | null

The request field that caused the error, if applicable.

details
string | null

Additional context about the error.

warnings
Array of object (ApiWarning) | null

List of non-fatal warnings from the request.

object

Represents a non-fatal warning from the API.

code
string

Machine-readable warning code.

Min length1
message
string

Human-readable warning message.

Min length1
401

Authentication token is missing or invalid.

Headers
WWW-Authenticate
string
Indicates the authentication scheme required. Returns `Bearer` with optional `error` and `error_description` parameters per RFC 6750.
Missing or invalid token

Authentication token is missing or invalid.

{
  "type": "https://developer.document360.com/errors/unauthorized",
  "title": "Unauthorized.",
  "status": 401,
  "detail": "The authentication token is missing or has expired.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Bearer token is missing or invalid.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
Expand All
object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type
string

URI reference identifying the error type (links to documentation).

Min length1
title
string

Short human-readable summary of the error type.

Min length1
status
integer (int32)

HTTP status code.

detail
string | null

Human-readable explanation specific to this occurrence.

instance
string | null

URI of the request that generated the error.

trace_id
string | null

Request trace identifier for correlation.

errors
Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code
string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1
message
string

Human-readable error message.

Min length1
field
string | null

The request field that caused the error, if applicable.

details
string | null

Additional context about the error.

warnings
Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code
string

Machine-readable warning code.

Min length1
message
string

Human-readable warning message.

Min length1
404

Folder not found.

Resource not found

The requested resource was not found.

{
  "type": "https://developer.document360.com/errors/not-found",
  "title": "Not Found.",
  "status": 404,
  "detail": "The requested resource does not exist or has been deleted.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "RESOURCE_NOT_FOUND",
      "message": "The requested resource was not found.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
Expand All
object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type
string

URI reference identifying the error type (links to documentation).

Min length1
title
string

Short human-readable summary of the error type.

Min length1
status
integer (int32)

HTTP status code.

detail
string | null

Human-readable explanation specific to this occurrence.

instance
string | null

URI of the request that generated the error.

trace_id
string | null

Request trace identifier for correlation.

errors
Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code
string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1
message
string

Human-readable error message.

Min length1
field
string | null

The request field that caused the error, if applicable.

details
string | null

Additional context about the error.

warnings
Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code
string

Machine-readable warning code.

Min length1
message
string

Human-readable warning message.

Min length1
429

Rate limit exceeded. Retry after the duration specified in the Retry-After header.

Headers
Retry-After
integer
Number of seconds to wait before retrying the request. Use exponential backoff with jitter for optimal retry behavior.
X-RateLimit-Limit
integer
The maximum number of requests allowed in the current time window. Limits are applied per API token per project.
X-RateLimit-Remaining
integer
The number of requests remaining in the current time window. When this reaches 0, subsequent requests will receive a 429 response.
X-RateLimit-Reset
integer
The UTC epoch timestamp (in seconds) when the current rate limit window resets.
Rate limit exceeded

Rate limit exceeded.

{
  "type": "https://developer.document360.com/errors/too-many-requests",
  "title": "Too Many Requests.",
  "status": 429,
  "detail": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "message": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
Expand All
object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type
string

URI reference identifying the error type (links to documentation).

Min length1
title
string

Short human-readable summary of the error type.

Min length1
status
integer (int32)

HTTP status code.

detail
string | null

Human-readable explanation specific to this occurrence.

instance
string | null

URI of the request that generated the error.

trace_id
string | null

Request trace identifier for correlation.

errors
Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code
string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1
message
string

Human-readable error message.

Min length1
field
string | null

The request field that caused the error, if applicable.

details
string | null

Additional context about the error.

warnings
Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code
string

Machine-readable warning code.

Min length1
message
string

Human-readable warning message.

Min length1
500

An unexpected server error occurred.

Unexpected server error

Unexpected server error.

{
  "type": "https://developer.document360.com/errors/internal-error",
  "title": "Internal Server Error.",
  "status": 500,
  "detail": "An unexpected error occurred. Please try again or contact support.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "message": "An unexpected error occurred.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
Expand All
object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type
string

URI reference identifying the error type (links to documentation).

Min length1
title
string

Short human-readable summary of the error type.

Min length1
status
integer (int32)

HTTP status code.

detail
string | null

Human-readable explanation specific to this occurrence.

instance
string | null

URI of the request that generated the error.

trace_id
string | null

Request trace identifier for correlation.

errors
Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code
string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1
message
string

Human-readable error message.

Min length1
field
string | null

The request field that caused the error, if applicable.

details
string | null

Additional context about the error.

warnings
Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code
string

Machine-readable warning code.

Min length1
message
string

Human-readable warning message.

Min length1

Was this article helpful?